Add AI app user guide by rpandya28 · Pull Request #420 · open-edge-platform/image-composer-tool

rpandya28 · 2026-02-17T17:38:02Z

Merge Checklist

All boxes should be checked before merging the PR

[] The changes in the PR have been built and tested
[] Ready to merge

Description

Any Newly Introduced Dependencies

How Has This Been Tested?

Copilot

Pull request overview

This PR adds a comprehensive user guide for Docker-based AI applications including Ollama chat Q&A, face recognition, and Intel DL Streamer face detection. However, this content appears to be out of scope for the OS Image Composer repository, which is specifically focused on building custom Linux images from pre-built packages.

Changes:

Adds new tutorial documentation for running Docker-based AI applications
Includes proxy configuration templates for Docker environments
Provides examples for Ollama LLM chat, face recognition containers, and DL Streamer pipelines

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-17T17:42:27Z

@@ -0,0 +1,209 @@
+
+# Docker‑Based Chat Q&A, Face Recognition & DL Streamer Face Detection


The "How Has This Been Tested?" section in the PR description is empty but marked as required. Documentation changes should be tested by verifying that the commands work correctly and that the documentation renders properly.

Copilot · 2026-02-17T17:42:29Z

+- Ready‑to‑run DL Streamer pipelines  
+- Comprehensive model‑proc files  
+- Multi-stage pipelines (detect → track → classify → action recognition)  
+- Optimized GStreamer graphs for edge deployments  
+- Reusable components for real‑time video analytics  


Multiple instances throughout the document use Unicode non-breaking hyphens (‑) instead of standard ASCII hyphens. This includes "Ready‑to‑run" (line 190), "Real‑time" (line 194), and others. Replace all Unicode hyphens with standard ASCII hyphens (-) for better compatibility, searchability, and consistency with standard markdown practices.

@copilot open a new pull request to apply changes based on this feedback

magerstam · 2026-02-17T23:43:59Z

+
+## 1. Prerequisites
+
+- OS with Docker Engine installed and running


I would point, embed, a hyperlink to the official docker installation page

we are adding required packages in yaml file. I have added this as part of pre.req.

magerstam · 2026-02-17T23:44:38Z

+
+- OS with Docker Engine installed and running
+- (Optional) Corporate proxy details if you are behind a proxy
+- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`


Link to install guide for this step?

We are not installing externally adding packages in yaml and building images

Sorry, my comment was on the prerequisites; you're stating that dlstreamer should be installed under /opt/intel/dlstreamer. Link to documentation for the user to install these? It may not be intuitive.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

magerstam · 2026-02-23T16:13:57Z

@rpandya28 several comments to resolve on this PR until we can merge, can you please have a look and disposition these?

wiwaszko-intel

Just one small issue with the name (OS Image Composer is the approved name). Consider the additional suggestions for links.

Other than that, LGTM.

wiwaszko-intel · 2026-03-03T08:01:08Z

+- Add DL Streamer and Docker based packages as part of os image composer build process using its multi repo feature 
+- OS with Docker Engine installed via and running
+- (Optional) Corporate proxy details if you are behind a proxy
+- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`


Suggested change

- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`

- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`. For information on installing DL Streamer, see its [documentation](https://docs.openedgeplatform.intel.com/2026.0/edge-ai-libraries/dlstreamer/get_started/install/install_guide_index.html)

wiwaszko-intel

See the suggestions and my other comment.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Wiktor Iwaszko <wiktorx.iwaszko@intel.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.

Copilot · 2026-03-06T04:34:53Z

+
+---
+
+## 5. DL Streamer – Face Detection Pipeline 


The heading contains an en dash ("–") and trailing whitespace. For better consistency and terminal/markdown compatibility, prefer a normal hyphen "-" and remove the trailing space.

Suggested change

## 5. DL Streamer – Face Detection Pipeline

## 5. DL Streamer - Face Detection Pipeline

Copilot · 2026-03-06T04:34:53Z

+  -e HTTP_PROXY="<HTTP_PROXY_URL>" \
+  -e HTTPS_PROXY="<HTTPS_PROXY_URL>" \
+  -e NO_PROXY="<NO_PROXY_LIST>" \
+  ollama/ollama


The Docker images in the examples are referenced without an explicit tag or digest (e.g., "ollama/ollama"), which can lead to non-reproducible behavior and increases supply-chain risk if the "latest" tag changes. Prefer pinning to a specific version tag (or digest) and/or add a brief note explaining which version was validated.

Suggested change

ollama/ollama

ollama/ollama:0.3.14 # Example validated version; update tag as needed

Copilot · 2026-03-06T04:34:53Z

+### 4.1 Run the container and enter shell
+
+```bash
+sudo docker run -it aaftio/face_recognition /bin/bash


Similarly, the face recognition example uses an unpinned third-party image ("aaftio/face_recognition") with no tag/digest. Pinning the image (and optionally linking to the upstream repo or noting the expected image provenance) would make the tutorial more reproducible and reduce the risk of pulling an unexpected image.

Suggested change

sudo docker run -it aaftio/face_recognition /bin/bash

sudo docker run -it aaftio/face_recognition:latest /bin/bash

Copilot · 2026-03-06T04:34:53Z

+# Example Workload: Docker‑Based Chat Q&A, Face Recognition & DL Streamer Face Detection
+
+*An example guide for running Docker-based AI workloads (Ollama chat, face recognition, DL Streamer face detection) on a Linux image created with OS Image Composer.*


The tutorial filename uses underscores and mixed casing ("user_guide_dlstreamer_docker_based_AI_app.md"), while other files under docs/tutorial use kebab-case (e.g., "usage-guide.md", "configure-secure-boot.md"). Consider renaming this file to kebab-case for consistency and easier linking/discoverability (e.g., "user-guide-dlstreamer-docker-based-ai-app.md").

Copilot · 2026-03-06T04:34:54Z

+export PATH=/opt/intel/dlstreamer/gstreamer/bin:/opt/intel/dlstreamer/bin:$PATH
+
+export MODELS_PATH=/home/${USER}/intel/models
+```
+
+Verify plugins:
+```bash
+gst-inspect-1.0 | grep -E "gvadetect|gvawatermark|gvatrack|gvaclassify"
+```
+
+### 5.2 Download the model (OMZ tools)
+
+> If you don’t have OMZ tools: `python3 -m pip install openvino-dev` (use a venv if your distro enforces PEP 668).
+
+```bash
+omz_downloader --name face-detection-adas-0001
+```
+
+The IR will be available at (example):
+```
+~/intel/face-detection-adas-0001/FP32/face-detection-adas-0001.xml
+```


The model directory/path guidance is inconsistent: you export MODELS_PATH as "/home/${USER}/intel/models", but the next section says OMZ outputs to "~/intel/face-detection-adas-0001/...". Consider either (1) setting omz_downloader --output_dir "$MODELS_PATH" and updating the example paths accordingly, or (2) updating MODELS_PATH to match the documented output location.

rpandya28 and others added 2 commits February 17, 2026 16:50

add user guide for AI app

035a179

Update user_guide_dlstreamer_docker_based_AI_app.md

7ef0c09

rpandya28 requested a review from srmungar February 17, 2026 17:38

rpandya28 requested a review from a team as a code owner February 17, 2026 17:38

Copilot AI review requested due to automatic review settings February 17, 2026 17:38

Copilot started reviewing on behalf of rpandya28 February 17, 2026 17:38 View session

Copilot AI reviewed Feb 17, 2026

View reviewed changes

magerstam reviewed Feb 17, 2026

View reviewed changes

rpandya28 and others added 5 commits February 18, 2026 08:49

Update user_guide_dlstreamer_docker_based_AI_app.md

1341f4c

Update user_guide_dlstreamer_docker_based_AI_app.md

0bca352

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

ec3c73f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

1c9383f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

e58b9a2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

srmungar reviewed Feb 18, 2026

View reviewed changes

Comment thread docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

srmungar reviewed Feb 18, 2026

View reviewed changes

Comment thread docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

Update user_guide_dlstreamer_docker_based_AI_app.md

6df96e8

wiwaszko-intel reviewed Mar 3, 2026

View reviewed changes

wiwaszko-intel approved these changes Mar 3, 2026

View reviewed changes

rpandya28 and others added 9 commits March 3, 2026 14:44

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

bd01fac

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

8af3ae3

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update docs/tutorial/user_guide_dlstreamer_docker_based_AI_app.md

b428332

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @wiwaszko-intel

b74f8d9

Co-authored-by: Wiktor Iwaszko <wiktorx.iwaszko@intel.com>

Update user_guide_dlstreamer_docker_based_AI_app.md

0248ef5

Merge branch 'main' into add-face-detection-doc

e70741c

Apply suggestion from @Copilot

1996147

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update user_guide_dlstreamer_docker_based_AI_app.md

e19a198

Update user_guide_dlstreamer_docker_based_AI_app.md

494adf0

rpandya28 requested a review from Copilot March 6, 2026 04:31

Copilot started reviewing on behalf of rpandya28 March 6, 2026 04:32 View session

Copilot AI reviewed Mar 6, 2026

View reviewed changes

rpandya28 added 3 commits March 6, 2026 21:25

Update user_guide_dlstreamer_docker_based_AI_app.md

ecb43fe

Update user_guide_dlstreamer_docker_based_AI_app.md

c41d35c

Update user_guide_dlstreamer_docker_based_AI_app.md

57568f9

		@@ -0,0 +1,209 @@

		# Docker‑Based Chat Q&A, Face Recognition & DL Streamer Face Detection


		## 1. Prerequisites

		- OS with Docker Engine installed and running

	- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`
	- For DL Streamer section: Intel® DL Streamer installed under `/opt/intel/dlstreamer/`. For information on installing DL Streamer, see its [documentation](https://docs.openedgeplatform.intel.com/2026.0/edge-ai-libraries/dlstreamer/get_started/install/install_guide_index.html)

	## 5. DL Streamer – Face Detection Pipeline
	## 5. DL Streamer - Face Detection Pipeline

	ollama/ollama
	ollama/ollama:0.3.14 # Example validated version; update tag as needed

	sudo docker run -it aaftio/face_recognition /bin/bash
	sudo docker run -it aaftio/face_recognition:latest /bin/bash

		# Example Workload: Docker‑Based Chat Q&A, Face Recognition & DL Streamer Face Detection

		An example guide for running Docker-based AI workloads (Ollama chat, face recognition, DL Streamer face detection) on a Linux image created with OS Image Composer.

Conversation

rpandya28 commented Feb 17, 2026

Merge Checklist

Description

Any Newly Introduced Dependencies

How Has This Been Tested?

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

rpandya28 Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

magerstam Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

rpandya28 Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

magerstam Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

rpandya28 Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

magerstam Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

magerstam commented Feb 23, 2026

Uh oh!

wiwaszko-intel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

wiwaszko-intel Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wiwaszko-intel left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

wiwaszko-intel Mar 3, 2026 •

edited

Loading